Skip to main content

Listar colaboradores

GETBase URL
/:companyId/banking/payroll/employees

Retorna lista paginada de colaboradores das empresas informadas com filtros opcionais. Paginação por cursor: use o valor de _links.next.href para navegar entre páginas.

Status do colaborador:

StatusSignificado
activeColaborador ativo com conta BTG
pendingOnboarding em andamento, conta ainda não ativada
suspendedConta suspensa
inactiveColaborador desligado

📘 Ambiente de sandbox

Esta API utiliza o Wiremock

No sandbox este endpoint requer a utilização de Sandbox Headers

HeaderDescriçãoValores Aceitos
x-responseControlar o tipo de resposta da API.success ou error

Request Specifications

Request

Responses

OK